Use which-key-idle-secondary-delay value in manual updates

diff --git a/README.org b/README.org
index a4133449149415c8d5f0746a6199795b7164c18f..ee573886365730bc21217a178f336dca3452051f 100644 (file)
--- a/README.org
+++ b/README.org
@@ -142,10 +142,13 @@
    along the following lines
 
    #+BEGIN_SRC emacs-lisp
-   ;; make sure which-key doesn't show normally
-   (setq which-key-idle-delay 1000)
-   (which-key-mode)
-   (setq prefix-help-command 'which-key-manual-update)
+     ;; make sure which-key doesn't show normally
+     (setq which-key-idle-delay 1000)
+     ;; which-key-manual-update uses this variable to control refreshing the
+     ;; which-key buffer after new keypresses
+     (setq which-key-idle-secondary-delay 0.05)
+     (which-key-mode)
+     (setq prefix-help-command 'which-key-manual-update)
    #+END_SRC
 
    This will prevent which-key from showing automatically, and allow you to use

diff --git a/which-key.el b/which-key.el
index b6ae9125f1ef2a8d5f0e0a19cd6c96dce5650211..8937436bd22a6199d18c7e972a931330c2451009 100644 (file)
--- a/which-key.el
+++ b/which-key.el
@@ -2588,12 +2588,13 @@ Finally, show the buffer."
 (defun which-key-manual-update ()
   "Force which-key update.
 
-This command is intended to be used for `prefix-help-command', as
-follows
+This command is intended to be used for `prefix-help-command'. An
+example configuration for using this command is the following.
 
-\(setq prefix-help-command 'which-key-manual-update).
-
-This should be set after activating `which-key-mode'."
+\(setq which-key-idle-delay 1000)
+\(setq which-key-idle-secondary-delay 0.05)
+\(which-key-mode)
+\(setq prefix-help-command 'which-key-manual-update)"
   (interactive)
   (if (which-key--popup-showing-p)
       (which-key-C-h-dispatch)
@@ -2601,7 +2602,9 @@ This should be set after activating `which-key-mode'."
             (butlast
              (listify-key-sequence (which-key--this-command-keys)))))
       (which-key-reload-key-sequence current-prefix)
-      (which-key--start-timer 0.05 t))))
+      (if which-key-idle-secondary-delay
+          (which-key--start-timer which-key-idle-secondary-delay t)
+        (which-key--start-timer 0.05 t)))))
 
 (defun which-key--update ()
   "Function run by timer to possibly trigger
@@ -2689,7 +2692,11 @@ This should be set after activating `which-key-mode'."
                                 (not (equal (which-key--current-prefix)
                                             (which-key--this-command-keys)))))
                    (cancel-timer which-key--paging-timer)
-                   (which-key--start-timer))))))
+                   (if which-key-idle-secondary-delay
+                       ;; we haven't executed a command yet so the secandary
+                       ;; timer is more relevant here
+                       (which-key--start-timer which-key-idle-secondary-delay t)
+                     (which-key--start-timer)))))))
 
 (provide 'which-key)
 ;;; which-key.el ends here